Skip to content

PD-2218 / 25.10 / Pd 2218 update replication task content (by micjohnson777) #4204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Oct 9, 2025
Merged

PD-2218 / 25.10 / Pd 2218 update replication task content (by micjohnson777) #4204

merged 5 commits into from
Oct 9, 2025

Conversation

bugclerk
Copy link
Contributor

@bugclerk bugclerk commented Oct 3, 2025

Automatic cherry-pick failed. Please resolve conflicts by running:

git reset --hard HEAD~1
git cherry-pick -x bc11936e180a00f689c9ea338188a9a8b13e472f
git cherry-pick -x c320b9cb46dea784185dfe0602d406500c63ba4c
git cherry-pick -x 71693136cf444773846d2f883b9b5707a27eca5e
git cherry-pick -x 143f805a47b82d28d4531147c6dddc7bf67f68ed
git cherry-pick -x 46e5c0654d09ef18f11cddb9efc74666a211911f
git cherry-pick -x 9cb85bb3ccade3f74a665a7602c8b1267d1e6845
git cherry-pick -x 953506c6a3af0b3ad77633d0a1cd51bda1229b2e
git cherry-pick -x 64df63d75a50206d2aea0ea050f300729b3ae684
git cherry-pick -x e2cbdab57391759f5567bbce925871caaeede128
git cherry-pick -x 4f9503df0de899f3b1b4c51c6b26fa02ef575960
git cherry-pick -x f01758664a2c6d85e2eac81741f3c2487f4a89cb
git cherry-pick -x 04343c24fbca8273a68dc8a78847f0c506ee74e4
git cherry-pick -x 7bdc269d1574836d646e22abea5f1a4c745afdcf
git cherry-pick -x 0b799ca2bc966480712822af44116d41258487d6
git cherry-pick -x 63cd03d88e836e24b9cce1b1155e1e008df6f44f
git cherry-pick -x 307b9b2d955ad969908624c1232ac39fb2b750df
git cherry-pick -x 1dc5bb26a0cf6fd31311b52f3025deca119fee17

If the original PR was merged via a squash, you can just cherry-pick the squashed commit:

git reset --hard HEAD~1
git cherry-pick -x 4c4a449532ce334a725fcd5c9f04bba4e535025f

This PR updates the replication UI ref and tutorials with new screenshots and descriptions, changed procedures related to UI changes. It creates new snippets and modifies the existing BasicReplicationProcess.md snippet.

Unused replication snippets will be deleted.

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

Original PR: #4191
Jira URL: https://ixsystems.atlassian.net/browse/PD-2218

micjohnson777 and others added 2 commits October 7, 2025 08:08
@micjohnson777 @linzi-ix
PD-2218 / 26.04 / Pd 2218 update replication task content (#4191)
bb98e11 
* PD-2218 Update Replication UI Ref

Added changes based on the way the Advanced Replication Creation button operates, and fixed a few descriptions for screens and settings that needed clarifications.

* PD-2218 Update Language about switching  between screens

This commit updates the language about switching between the wizard and add task screen to remove duplication.

* PD-2218 Replication Updates

initial changes

* PD-2218 Update UI ref and main replication tutorial index

This commit updates the ReplicationScreensSCALE.md article with new or changed definitions, and updates the BasicReplicationProcess.md snippet by breaking the local and remote overviews into individual sections, and updates each step to reflect the current processes

* PD-2218 Create New Snippets Rewrite Remote Replication

This commit rewrites the RemoteReplicationSCALE.md tutorial, using new snippets to streamline the process to set up replication tasks.

* PD-2218 Grammer, Spelling, and Content check

This commit includes a grammar/spelling check and makes a few minor changes where needed.

* PD-2218 Update Local Replication Tutorial

This commit updates the LocalReplicationSCALE.md tutorial to use the new snippets

Renames the ReplicationWizardSteps4Thru6.md to ReplicationWizardSteps5And6.md, which moves the Replicate Custom Snapshot content up to step 4 and makes it part of the base content in the RemoteReplicationSCALE.md tutorial. It does not apply to local replication.

* PD-2218 Save changes not in previous commit

* PD-2218 Saves changes in Remote Replication not in the two previous commits

* PD-2218 Update Advanced Replication

Update the AdvancedReplication/_index.md file content to work with the changed BasicReplicationProcess.md snippet.

* PD-2218 Update the ReplicationWithEncryptionSCALE.md Tutorial

This commit makes changes to the tutorial for replication using encryption. It removes the old procedure and updates with a referal to the RemoteReplicationSCALE.md tutorial, and updates that tutorial with the optional encryption setting. It removes duplicated content and focuses the article on replication and encryption options.

* PD-2218 Update the AddSSHConnection.md snippet

Added information about the connection after it is added in TrueNAS.

* typo corrections

---------

Co-authored-by: linzibelle <[email protected]>
Co-authored-by: linzi-ix <[email protected]>
(cherry picked from commit 4c4a449)
@micjohnson777
Merge branch 'PD-2218-25.10' of https://github.com/truenas/documentation
68e3c3c 
 into PD-2218-25.10
@micjohnson777 micjohnson777 marked this pull request as ready for review October 7, 2025 12:08
@micjohnson777 micjohnson777 requested a review from a team as a code owner October 7, 2025 12:08
@github-actions

This comment was marked as duplicate.

Sign in to view
@github-actions
Copy link

github-actions bot commented Oct 7, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 405 issues found in changed files - 39 errors, 24 warnings, 342 suggestions

Changed files with issues:

content/SCALEUIReference/DataProtection/ReplicationScreensSCALE.md (130 issues)

  • Lines 27, 63 - error: 'Edit' is repeated!
  • Lines 31, 61, 77 - error: 'Restore' is repeated!
  • Lines 35, 65, 89 - error: 'Delete' is repeated!
  • Lines 37, 116, 290, 306 - suggestion: Keep sentences under 30 words
  • Line 84 - suggestion: Use Title Case for headings
  • Lines 96, 97, 98, 106, 118, 124, 143, 148, 152, 172, 180, 190, 193, 205, 214, 216, 221, 228, 251, 256, 266, 267, 268, 275, 283, 290, 299, 306, 315, 317, 318, 319, 355, 357, 358, 381, 400 - suggestion: Avoid contractions in formal writing
  • Lines 141, 283 - suggestion: Verify your use of 'Allows' with the A-Z word list.
  • Line 150 - suggestion: Use single space after periods and single empty lines between paragraphs
  • Lines 151, 360 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 152 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 180, 284 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 180 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 189, 190 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 283, 284, 290, 306 - suggestion: Verify your use of 'Allow' with the A-Z word list.
  • Lines 290, 306 - suggestion: Spell out 'WRITE' on first use
  • Line 298 - error: 'the' is repeated!

content/SCALETutorials/DataProtection/Replication/AdvancedReplication/_index.md (64 issues)

  • Lines 3, 41, 79 - suggestion: Spell out 'ZFS' on first use
  • Lines 3, 75, 86 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 17, 18, 40, 87, 101, 116, 167 - suggestion: Keep sentences under 30 words
  • Lines 17, 115 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 17, 25, 48, 87, 91, 116, 134, 138, 166, 167 - suggestion: Avoid contractions in formal writing
  • Line 17 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Line 18 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Lines 34, 81, 87 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 47 - suggestion: Use the Oxford comma in 'replication, local or remote.'.
  • Lines 64, 142 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 69 - suggestion: Spell out 'LOCAL' on first use
  • Line 79 - error: 'to' is repeated!
  • Line 91 - suggestion: Verify your use of 'and/or' with the A-Z word list.
  • Line 94 - suggestion: Spell out 'NOT' on first use
  • Line 129 - suggestion: Spell out 'WRITE' on first use
  • Line 134 - suggestion: Verify your use of 'Allow' with the A-Z word list.
  • Line 140 - warning: Remove 'quickly' if it's not important to the meaning of the statement.
  • Line 172 - suggestion: Spell out 'HEX' on first use
  • Line 181 - warning: Remove 'very' if it's not important to the meaning of the statement.
  • Line 187 - warning: Remove 'generally' if it's not important to the meaning of the statement.

static/includes/ReplicationRemoteBeforeYouBegin.md (39 issues)

  • Lines 5, 24, 26, 30, 31, 39, 56 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 10, 16, 26, 30, 42 - suggestion: Avoid contractions in formal writing
  • Lines 12, 39 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 13, 22, 28, 33, 56 - suggestion: Keep sentences under 30 words
  • Lines 13, 33 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 33, 34 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 39 - error: 'to' is repeated!
  • Lines 49, 54 - suggestion: Verify your use of 'Allow' with the A-Z word list.

content/SCALETutorials/DataProtection/Replication/RemoteReplicationSCALE.md (39 issues)

  • Lines 17, 58 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 17, 19, 36, 49, 75, 80, 81 - suggestion: Avoid contractions in formal writing
  • Line 17 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Lines 17, 20, 30, 61, 63 - suggestion: Spell out 'ZFS' on first use
  • Lines 17, 47, 52 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 19, 34, 49, 52 - suggestion: Keep sentences under 30 words
  • Line 47 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Line 54 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 58 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 81 - warning: Avoid using 'Will'

content/SCALETutorials/DataProtection/Replication/AdvancedReplication/ReplicationWithEncryptionSCALE.md (28 issues)

  • Line 13 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 13, 17, 35, 39, 70 - suggestion: Avoid contractions in formal writing
  • Lines 16, 20, 33, 56, 73, 83 - suggestion: Keep sentences under 30 words
  • Lines 20, 30, 38 - suggestion: Spell out 'ZFS' on first use
  • Lines 24, 31 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 56 - suggestion: Verify your use of 'above' with the A-Z word list.

content/SCALETutorials/DataProtection/Replication/LocalReplicationSCALE.md (24 issues)

  • Lines 17, 37 - suggestion: Spell out 'ZFS' on first use
  • Line 17 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 18, 61 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 18, 20, 21, 43, 66 - suggestion: Avoid contractions in formal writing
  • Lines 23, 41, 65 - suggestion: Keep sentences under 30 words
  • Line 23 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 23 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Line 54 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 61 - suggestion: Verify your use of 'allow' with the A-Z word list.

static/includes/AddSSHConnection.md (16 issues)

  • Line 17 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 21, 24, 26, 28 - suggestion: Avoid contractions in formal writing
  • Lines 21, 36 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands

static/includes/ReplicationWizardSteps1and2.md (13 issues)

  • Line 3 - suggestion: Keep sentences under 30 words
  • Line 3 - suggestion: Verify your use of 'Ensure' with the A-Z word list.
  • Lines 4, 14, 17, 20, 22, 23, 27 - suggestion: Avoid contractions in formal writing
  • Line 7 - suggestion: Verify your use of 'above' with the A-Z word list.

static/includes/ReplicationConfigNewSSHConnection.md (12 issues)

  • Lines 14, 16, 23 - suggestion: Avoid contractions in formal writing
  • Line 14 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 21, 33 - suggestion: Keep sentences under 30 words
  • Line 24 - error: 'the' is repeated!
  • Line 24 - suggestion: Spell out 'ZFS' on first use

static/includes/ReplicationLocalBeforeYouBegin.md (11 issues)

  • Lines 5, 6 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 8, 13, 14 - suggestion: Avoid contractions in formal writing
  • Line 9 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 11, 20 - suggestion: Keep sentences under 30 words
  • Line 11 - suggestion: Verify your use of 'allows' with the A-Z word list.

content/SCALETutorials/DataProtection/Replication/_index.md (10 issues)

  • Line 3 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 3 - suggestion: Spell out 'ZFS' on first use
  • Line 13 - suggestion: Keep sentences under 30 words
  • Line 13 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 13 - suggestion: Avoid contractions in formal writing
  • Line 13 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Line 14 - warning: Remove 'properly' if it's not important to the meaning of the statement.

static/includes/ReplicationScheduleAndRetentionSteps.md (10 issues)

  • Lines 6, 11, 13 - suggestion: Avoid contractions in formal writing
  • Lines 25, 26 - suggestion: Keep sentences under 30 words

static/includes/ReplicationIndexContentSCALE.md (5 issues)

  • Lines 3, 4 - suggestion: Avoid contractions in formal writing

static/includes/ReplicationSSHTransferSecurity.md (3 issues)

  • Line 4 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 4 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 7 - suggestion: Avoid contractions in formal writing

static/includes/ReplicationWizardSteps5And6.md (1 issues)

  • Line 7 - suggestion: Avoid contractions in formal writing

🔧 To fix: Review the issues above and update your documentation accordingly.

@github-actions
Copy link

github-actions bot commented Oct 9, 2025

Vale Style Guide Issues

📊 Summary: 405 issues found in changed files - 39 errors, 24 warnings, 342 suggestions

Changed files with issues:

content/SCALEUIReference/DataProtection/ReplicationScreensSCALE.md (130 issues)

  • Lines 27, 63 - error: 'Edit' is repeated!
  • Lines 31, 61, 77 - error: 'Restore' is repeated!
  • Lines 35, 65, 89 - error: 'Delete' is repeated!
  • Lines 37, 116, 290, 306 - suggestion: Keep sentences under 30 words
  • Line 84 - suggestion: Use Title Case for headings
  • Lines 96, 97, 98, 106, 118, 124, 143, 148, 152, 172, 180, 190, 193, 205, 214, 216, 221, 228, 251, 256, 266, 267, 268, 275, 283, 290, 299, 306, 315, 317, 318, 319, 355, 357, 358, 381, 400 - suggestion: Avoid contractions in formal writing
  • Lines 141, 283 - suggestion: Verify your use of 'Allows' with the A-Z word list.
  • Line 150 - suggestion: Use single space after periods and single empty lines between paragraphs
  • Lines 151, 360 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 152 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 180, 284 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 180 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 189, 190 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 283, 284, 290, 306 - suggestion: Verify your use of 'Allow' with the A-Z word list.
  • Lines 290, 306 - suggestion: Spell out 'WRITE' on first use
  • Line 298 - error: 'the' is repeated!

content/SCALETutorials/DataProtection/Replication/AdvancedReplication/_index.md (64 issues)

  • Lines 3, 75, 86 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 3, 41, 79 - suggestion: Spell out 'ZFS' on first use
  • Lines 17, 18, 40, 87, 101, 116, 167 - suggestion: Keep sentences under 30 words
  • Lines 17, 115 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 17, 25, 48, 87, 91, 116, 134, 138, 166, 167 - suggestion: Avoid contractions in formal writing
  • Line 17 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Line 18 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Lines 34, 81, 87 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 47 - suggestion: Use the Oxford comma in 'replication, local or remote.'.
  • Lines 64, 142 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 69 - suggestion: Spell out 'LOCAL' on first use
  • Line 79 - error: 'to' is repeated!
  • Line 91 - suggestion: Verify your use of 'and/or' with the A-Z word list.
  • Line 94 - suggestion: Spell out 'NOT' on first use
  • Line 129 - suggestion: Spell out 'WRITE' on first use
  • Line 134 - suggestion: Verify your use of 'Allow' with the A-Z word list.
  • Line 140 - warning: Remove 'quickly' if it's not important to the meaning of the statement.
  • Line 172 - suggestion: Spell out 'HEX' on first use
  • Line 181 - warning: Remove 'very' if it's not important to the meaning of the statement.
  • Line 187 - warning: Remove 'generally' if it's not important to the meaning of the statement.

static/includes/ReplicationRemoteBeforeYouBegin.md (39 issues)

  • Lines 5, 24, 26, 30, 31, 39, 56 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 10, 16, 26, 30, 42 - suggestion: Avoid contractions in formal writing
  • Lines 12, 39 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 13, 22, 28, 33, 56 - suggestion: Keep sentences under 30 words
  • Lines 13, 33 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 33, 34 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 39 - error: 'to' is repeated!
  • Lines 49, 54 - suggestion: Verify your use of 'Allow' with the A-Z word list.

content/SCALETutorials/DataProtection/Replication/RemoteReplicationSCALE.md (39 issues)

  • Lines 17, 58 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 17, 19, 36, 49, 75, 80, 81 - suggestion: Avoid contractions in formal writing
  • Line 17 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Lines 17, 47, 52 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 17, 20, 30, 61, 63 - suggestion: Spell out 'ZFS' on first use
  • Lines 19, 34, 49, 52 - suggestion: Keep sentences under 30 words
  • Line 47 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Line 54 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 58 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 81 - warning: Avoid using 'Will'

content/SCALETutorials/DataProtection/Replication/AdvancedReplication/ReplicationWithEncryptionSCALE.md (28 issues)

  • Line 13 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 13, 17, 35, 39, 70 - suggestion: Avoid contractions in formal writing
  • Lines 16, 20, 33, 56, 73, 83 - suggestion: Keep sentences under 30 words
  • Lines 20, 30, 38 - suggestion: Spell out 'ZFS' on first use
  • Lines 24, 31 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 56 - suggestion: Verify your use of 'above' with the A-Z word list.

content/SCALETutorials/DataProtection/Replication/LocalReplicationSCALE.md (24 issues)

  • Lines 17, 37 - suggestion: Spell out 'ZFS' on first use
  • Line 17 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 18, 61 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 18, 20, 21, 43, 66 - suggestion: Avoid contractions in formal writing
  • Lines 23, 41, 65 - suggestion: Keep sentences under 30 words
  • Line 23 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 23 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Line 54 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 61 - suggestion: Verify your use of 'allow' with the A-Z word list.

static/includes/AddSSHConnection.md (16 issues)

  • Line 17 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 21, 24, 26, 28 - suggestion: Avoid contractions in formal writing
  • Lines 21, 36 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands

static/includes/ReplicationWizardSteps1and2.md (13 issues)

  • Line 3 - suggestion: Keep sentences under 30 words
  • Line 3 - suggestion: Verify your use of 'Ensure' with the A-Z word list.
  • Lines 4, 14, 17, 20, 22, 23, 27 - suggestion: Avoid contractions in formal writing
  • Line 7 - suggestion: Verify your use of 'above' with the A-Z word list.

static/includes/ReplicationConfigNewSSHConnection.md (12 issues)

  • Lines 14, 16, 23 - suggestion: Avoid contractions in formal writing
  • Line 14 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 21, 33 - suggestion: Keep sentences under 30 words
  • Line 24 - error: 'the' is repeated!
  • Line 24 - suggestion: Spell out 'ZFS' on first use

static/includes/ReplicationLocalBeforeYouBegin.md (11 issues)

  • Lines 5, 6 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 8, 13, 14 - suggestion: Avoid contractions in formal writing
  • Line 9 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 11, 20 - suggestion: Keep sentences under 30 words
  • Line 11 - suggestion: Verify your use of 'allows' with the A-Z word list.

content/SCALETutorials/DataProtection/Replication/_index.md (10 issues)

  • Line 3 - suggestion: Spell out 'ZFS' on first use
  • Line 3 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 13 - suggestion: Keep sentences under 30 words
  • Line 13 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 13 - suggestion: Avoid contractions in formal writing
  • Line 13 - warning: Remove 'regularly' if it's not important to the meaning of the statement.
  • Line 14 - warning: Remove 'properly' if it's not important to the meaning of the statement.

static/includes/ReplicationScheduleAndRetentionSteps.md (10 issues)

  • Lines 6, 11, 13 - suggestion: Avoid contractions in formal writing
  • Lines 25, 26 - suggestion: Keep sentences under 30 words

static/includes/ReplicationIndexContentSCALE.md (5 issues)

  • Lines 3, 4 - suggestion: Avoid contractions in formal writing

static/includes/ReplicationSSHTransferSecurity.md (3 issues)

  • Line 4 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 4 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 7 - suggestion: Avoid contractions in formal writing

static/includes/ReplicationWizardSteps5And6.md (1 issues)

  • Line 7 - suggestion: Avoid contractions in formal writing

🔧 To fix: Review the issues above and update your documentation accordingly.

@linzi-ix linzi-ix added the Technical Writer Review (LM) A technical writer is reviewing the PR. label Oct 9, 2025
@linzi-ix linzi-ix merged commit 50d8c87 into 25.10 Oct 9, 2025
4 checks passed
@linzi-ix linzi-ix deleted the PD-2218-25.10 branch October 9, 2025 14:51
@bugclerk
Copy link
Contributor Author

bugclerk commented Oct 9, 2025

JIRA ticket https://ixsystems.atlassian.net/browse/PD-2218 is targeted to the following versions which have not received their corresponding PRs: 24.10

@bugclerk
Copy link
Contributor Author

bugclerk commented Oct 9, 2025

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.

@truenas truenas locked as resolved and limited conversation to collaborators Oct 9, 2025
@bugclerk
Copy link
Contributor Author

bugclerk commented Oct 9, 2025

JIRA ticket https://ixsystems.atlassian.net/browse/PD-2218 is targeted to the following versions which have not received their corresponding PRs: 24.10

@bugclerk
Copy link
Contributor Author

bugclerk commented Oct 9, 2025

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@linzi-ix linzi-ix linzi-ix approved these changes

Assignees

@micjohnson777 micjohnson777

Labels

Technical Writer Review (LM) A technical writer is reviewing the PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bugclerk @linzi-ix @micjohnson777